GET WellPurposes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves well purposes for the given parameters. This will only retrieve well purposes that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
take |
Number of well purposes to retrieve. Default is all well purposes |
integer |
None. |
skip |
Number of well purposes to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the well purposes before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of well purposes.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of WellPurpose |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "WellPurposeId": "5c6a128a-56c5-45d7-b966-4f424c6a7122", "Asset": { "AssetId": "a1fb254e-4000-4167-bd26-637ffda45cff", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "61917dd8-b53c-4a04-89a0-ed3d66edeef2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adce2a31-a530-438d-813c-8f228dc68f50", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "bf3324a7-adfa-451b-8018-d0939a9feeb6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "MeasurementValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "SourceSystemId": "sample string 3", "CompanyId": "cf456a42-3116-4dcd-8cad-1b90d58d7bbd", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1025f009-be05-47ce-9978-04e5ae87a404", "EffectiveDate": "2024-05-06T05:06:46.6826295-07:00", "StateType": { "StateTypeId": "cdff4d7e-74da-471b-b289-043eaea77600", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "61917dd8-b53c-4a04-89a0-ed3d66edeef2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adce2a31-a530-438d-813c-8f228dc68f50", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9f850b0a-63a2-4963-96db-5e5186db1e55", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "3f9c97ce-eb3d-478d-b00e-c657bc512ed5", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "246c77a3-ec02-40b8-87e6-bef719ed1d56", "EffectiveDate": "2024-05-06T05:06:46.6826295-07:00", "StatusType": { "StatusTypeId": "04b894f8-9572-44aa-9099-428b8a3bcf56", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "61917dd8-b53c-4a04-89a0-ed3d66edeef2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adce2a31-a530-438d-813c-8f228dc68f50", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b176f09d-6790-40fc-81f8-e8c1abba954c", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "065a2408-4ae6-4efe-b65f-d2d74773348d", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "MeasurementValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "cb6a48ae-6538-42c8-9921-8578c792bf86", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-05-06T05:06:46.6826295-07:00", "WellPurposeType": { "WellPurposeTypeId": "adba2ee2-39e8-49ef-9d5b-cfd225e209a8", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5a9affdb-7069-4ba3-b6d9-02a4e5799920", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "33022d78-72af-4058-a7e1-7f269d26b1e5", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 4" }, { "WellPurposeId": "5c6a128a-56c5-45d7-b966-4f424c6a7122", "Asset": { "AssetId": "a1fb254e-4000-4167-bd26-637ffda45cff", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "61917dd8-b53c-4a04-89a0-ed3d66edeef2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adce2a31-a530-438d-813c-8f228dc68f50", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "bf3324a7-adfa-451b-8018-d0939a9feeb6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "MeasurementValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "SourceSystemId": "sample string 3", "CompanyId": "cf456a42-3116-4dcd-8cad-1b90d58d7bbd", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1025f009-be05-47ce-9978-04e5ae87a404", "EffectiveDate": "2024-05-06T05:06:46.6826295-07:00", "StateType": { "StateTypeId": "cdff4d7e-74da-471b-b289-043eaea77600", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "61917dd8-b53c-4a04-89a0-ed3d66edeef2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adce2a31-a530-438d-813c-8f228dc68f50", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9f850b0a-63a2-4963-96db-5e5186db1e55", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "3f9c97ce-eb3d-478d-b00e-c657bc512ed5", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "246c77a3-ec02-40b8-87e6-bef719ed1d56", "EffectiveDate": "2024-05-06T05:06:46.6826295-07:00", "StatusType": { "StatusTypeId": "04b894f8-9572-44aa-9099-428b8a3bcf56", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "61917dd8-b53c-4a04-89a0-ed3d66edeef2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adce2a31-a530-438d-813c-8f228dc68f50", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b176f09d-6790-40fc-81f8-e8c1abba954c", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "065a2408-4ae6-4efe-b65f-d2d74773348d", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "MeasurementValueNeededDate": "2024-05-06T05:06:46.6826295-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "cb6a48ae-6538-42c8-9921-8578c792bf86", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-05-06T05:06:46.6826295-07:00", "WellPurposeType": { "WellPurposeTypeId": "adba2ee2-39e8-49ef-9d5b-cfd225e209a8", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5a9affdb-7069-4ba3-b6d9-02a4e5799920", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "33022d78-72af-4058-a7e1-7f269d26b1e5", "CreateDate": "2024-05-06T05:06:46.6826295-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T05:06:46.6826295-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }